package 集合.hashCode与equals;

//我们知道List是一种有序链表：List内部按照放入元素的先后顺序存放，并且每个元素都可以通过索引确定自己的位置。
//
//List还提供了boolean contains(Object o)方法来判断List是否包含某个指定元素。此外，int indexOf(Object o)方法可以返回某个元素的索引，如果元素不存在，就返回-1。
//
//我们来看一个例子：
//
//import java.util.List;
//public class Main {
//    public static void main(String[] args) {
//        List<String> list = List.of("A", "B", "C");
//        System.out.println(list.contains("C")); // true
//        System.out.println(list.contains("X")); // false
//        System.out.println(list.indexOf("C")); // 2
//        System.out.println(list.indexOf("X")); // -1
//        System.out.println("abc"=="abc");//true
//        System.out.println("abc"=="abcd".substring(0,3));//false
//        System.out.println("abc".equals("abcd".substring(0,3)));//true
//    }
//}
//
//这里我们注意一个问题，我们往List中添加的"C"和调用contains("C")传入的"C"是不是同一个实例？
//
//如果这两个"C"不是同一个实例，这段代码是否还能得到正确的结果？我们可以改写一下代码测试一下：
//
//import java.util.List;
//public class Main {
//    public static void main(String[] args) {
//        List<String> list = List.of("A", "B", "C");
//        System.out.println(list.contains(new String("C"))); // true or false?
//        System.out.println(list.indexOf(new String("C"))); // 2 or -1?
//    }
//}
//true
//2
//因为我们传入的是new String("C")，所以一定是不同的实例。结果仍然符合预期，这是为什么呢？
//
//因为List内部并不是通过==判断两个元素是否相等，而是使用equals()方法判断两个元素是否相等，例如contains()方法可以实现如下：
//
//public class ArrayList {
//    Object[] elementData;
//    public boolean contains(Object o) {
//        for (int i = 0; i < elementData.length; i++) {
//            if (o.equals(elementData[i])) {
//                return true;
//            }
//        }
//        return false;
//    }
//}
//因此，要正确使用List的contains()、indexOf()这些方法，放入的实例必须正确覆写equals()方法，否则，放进去的实例，查找不到。我们之所以能正常放入String、Integer这些对象，是因为Java标准库定义的这些类已经正确实现了equals()方法。
//
//我们以Person对象为例，测试一下：
//
//import java.util.List;
//public class Main {
//    public static void main(String[] args) {
//        List<Person> list = List.of(
//            new Person("Xiao Ming"),
//            new Person("Xiao Hong"),
//            new Person("Bob")
//        );
//        System.out.println(list.contains(new Person("Bob"))); // false
//    }
//}
//
//class Person {
//    String name;
//    public Person(String name) {
//        this.name = name;
//    }
//}
//
//不出意外，虽然放入了new Person("Bob")，但是用另一个new Person("Bob")查询不到，原因就是Person类没有覆写equals()方法。
//
//编写equals
//如何正确编写equals()方法？equals()方法要求我们必须满足以下条件：
//
//1.自反性（Reflexive）：对于非null的x来说，x.equals(x)必须返回true；
//2.对称性（Symmetric）：对于非null的x和y来说，如果x.equals(y)为true，则y.equals(x)也必须为true；
//3.传递性（Transitive）：对于非null的x、y和z来说，如果x.equals(y)为true，y.equals(z)也为true，那么x.equals(z)也必须为true；
//4.一致性（Consistent）：对于非null的x和y来说，只要x和y状态不变，则x.equals(y)总是一致地返回true或者false；若a.equal(b) 返回”true”, 只要a, b内容不变，不管重复多少次a.equal(b)必须返回”true”.
//5.对null的比较：任何类的对象不应等于空引用。即x.equals(null)永远返回false;x.equals(和x不同类型的对象)永远返回是false.
//6.与hashCode()方法的关系：如果x.equals(y)返回true，x.hashCode()必须返回与y.hashCode()相同的值。
//  如果x.hashCode()与y.hashCode()相同的值，x.equals(y)可以不返回true。-->冲突
//上述规则看上去似乎非常复杂，但其实代码实现equals()方法是很简单的，我们以Person类为例：
//
//public class Person {
//    public String name;
//    public int age;
//}
//首先，我们要定义“相等”的逻辑含义。对于Person类，如果name相等，并且age相等，我们就认为两个Person实例相等。
//
//因此，编写equals()方法如下：
//
//public boolean equals(Object o) {
//    if (o instanceof Person) {
//        Person p = (Person) o;
//        return this.name.equals(p.name) && this.age == p.age;
//    }
//    return false;
//}
//对于引用字段比较，我们使用equals()，对于基本类型字段的比较，我们使用==。
//
//如果this.name为null，那么equals()方法会报错，因此，需要继续改写如下：
//
//public boolean equals(Object o) {
//    if (o instanceof Person) {
//        Person p = (Person) o;
//        boolean nameEquals = false;
//        if (this.name == null && p.name == null) {
//            nameEquals = true;
//        }
//        if (this.name != null) {
//            nameEquals = this.name.equals(p.name);
//        }
//        return nameEquals && this.age == p.age;
//    }
//    return false;
//}
//如果Person有好几个引用类型的字段，上面的写法就太复杂了。要简化引用类型的比较，我们使用Objects.equals()静态方法：
//
//public boolean equals(Object o) {
//    if (o instanceof Person) {
//        Person p = (Person) o;
//        return Objects.equals(this.name, p.name) && this.age == p.age;
//    }
//    return false;
//}
//因此，我们总结一下equals()方法的正确编写方法：
//
//先确定实例“相等”的逻辑，即哪些字段相等，就认为实例相等；
//用instanceof判断传入的待比较的Object是不是当前类型，如果是，继续比较，否则，返回false；
//对引用类型用Objects.equals()比较，对基本类型直接用==比较。
//使用Objects.equals()比较两个引用类型是否相等的目的是省去了判断null的麻烦。两个引用类型都是null时它们也是相等的。
//
//如果不调用List的contains()、indexOf()这些方法，那么放入的元素就不需要实现equals()方法。
//
//练习
//给Person类增加equals方法，使得调用indexOf()方法返回正常：
//
//import java.util.List;
//import java.util.Objects;
//public class Main {
//    public static void main(String[] args) {
//        List<Person> list = List.of(
//            new Person("Xiao", "Ming", 18),
//            new Person("Xiao", "Hong", 25),
//            new Person("Bob", "Smith", 20)
//        );
//        boolean exist = list.contains(new Person("Bob", "Smith", 20));
//        System.out.println(exist ? "测试成功!" : "测试失败!");
//    }
//}
//
//class Person {
//    String firstName;
//    String lastName;
//    int age;
//    public Person(String firstName, String lastName, int age) {
//        this.firstName = firstName;
//        this.lastName = lastName;
//        this.age = age;
//    }
//}
//
// Run
//从下载练习：覆写equals方法 （推荐使用IDE练习插件快速下载）
//
//小结
//在List中查找元素时，List的实现类通过元素的equals()方法比较两个元素是否相等，因此，放入的元素必须正确覆写equals()方法，Java标准库提供的String、Integer等已经覆写了equals()方法；
//
//编写equals()方法可借助Objects.equals()判断。
//
//如果不在List中查找元素，就不必覆写equals()方法。

//在有些情况下，程序设计者在设计一个类的时候为需要重写equals方法，比如String类，但是千万要注意，在重写equals方法的同时，必须重写hashCode方法。为什么这么说呢？
/*import java.util.HashMap;
import java.util.HashSet;
import java.util.Objects;
import java.util.Set;
 
 
class People{
    private String name;
    private int age;
     
    public People(String name,int age) {
        this.name = name;
        this.age = age;
    }  
     
    public void setAge(int age){
        this.age = age;
    }
 
    @Override
    public int hashCode() {
        // TODO Auto-generated method stub
        return name.hashCode()*37+age;
    }
    
    @Override
    public boolean equals(Object obj) {
    	if (obj instanceof People) {
    		//People p=(People) obj;
    		//return Objects.equals(this.name, p.name)&& this.age==p.age;
    		return Objects.equals(this.name, ((People)obj).name)&& this.age==((People)obj).age;
    	}
    	return false;
        //return this.name.equals(((People)obj).name) && this.age== ((People)obj).age;
    }
}
 
public class 编写equals方法 {
 
    public static void main(String[] args) {
         
        People p1 = new People("Jack", 12);
        System.out.println(p1.hashCode());//1277181601
             
        HashMap<People, Integer> hashMap = new HashMap<People, Integer>();
        hashMap.put(p1, 1);
         
        System.out.println(hashMap.get(new People("Jack", 12)));//null
        System.out.println(hashMap.get(p1));//1
    }
}
*/

//在这里我只重写了equals方法，也就说如果两个People对象，如果它的姓名和年龄相等，则认为是同一个人。
//这段代码本来的意愿是想这段代码输出结果为“1”，但是事实上它输出的是“null”。为什么呢？原因就在于重写equals方法的同时忘记重写hashCode方法。
//
//虽然通过重写equals方法使得逻辑上姓名和年龄相同的两个对象被判定为相等的对象（跟String类类似），但是要知道默认情况下，hashCode方法是将对象的存
//储地址进行映射。那么上述代码的输出结果为“null”就不足为奇了。原因很简单，p1指向的对象和
//
//System.out.println(hashMap.get(new People("Jack", 12)));这句中的new People("Jack", 12)生成的是两个对象，它们的存储地址肯定不
//同。下面是HashMap的get方法的具体实现：

//public V get(Object key) {
//    if (key == null)
//        return getForNullKey();
//    int hash = hash(key.hashCode());
//    for (Entry<K,V> e = table[indexFor(hash, table.length)];
//         e != null;
//         e = e.next) {
//        Object k;
//        if (e.hash == hash && ((k = e.key) == key || key.equals(k)))
//            return e.value;
//    }
//    return null;
//}
//所以在hashmap进行get操作时，因为得到的hashcdoe值不同（注意，上述代码也许在某些情况下会得到相同的hashcode值，不过这种概率比较小，因为虽然两个对象的存储
//地址不同也有可能得到相同的hashcode值），所以导致在get方法中for循环不会执行，直接返回null。
//
//因此如果想上述代码输出结果为“1”，很简单，只需要重写hashCode方法，让equals方法和hashCode方法始终在逻辑上保持一致性。
//
//@Override
//public int hashCode() {
//    // TODO Auto-generated method stub
//    return name.hashCode()*37+age;
//}
//下面这段话摘自Effective Java一书：

//◾在程序执行期间，只要equals方法的比较操作用到的信息没有被修改，那么对这同一个对象调用多次，hashCode方法必须始终如一地返回同一个整数。
//◾如果两个对象根据equals方法比较是相等的，那么调用两个对象的hashCode方法必须返回相同的整数结果。
//◾如果两个对象根据equals方法比较是不等的，则hashCode方法不一定得返回不同的整数。
//对于第二条和第三条很好理解，但是第一条，很多时候就会忽略。在《Java编程思想》一书中的P495页也有同第一条类似的一段话：
//
//“设计hashCode()时最重要的因素就是：无论何时，对同一个对象调用hashCode()都应该产生同样的值。如果在将一个对象用put()添加进HashMap时产
//生一个hashCdoe值，而用get()取出时却产生了另一个hashCode值，那么就无法获取该对象了。所以如果你的hashCode方法依赖于对象中易变的数据，用
//户就要当心了，因为此数据发生变化时，hashCode()方法就会生成一个不同的散列码”。
//
//下面举个例子：

import java.util.HashMap;
import java.util.HashSet;
import java.util.Objects;
import java.util.Set;

class People {
	private String firstname;
	private String lastname;
	private int age;

	public People(String firstname,String lastname, int age) {
		this.firstname = firstname;
		this.lastname = lastname;
		this.age = age;
	}

	public void setAge(int age) {
		this.age = age;
	}

	@Override
	public int hashCode() {
		// TODO Auto-generated method stub

//		return h;//+ age; age易变，则最好在equals方法和hashCode方法中不要依赖于该字段
		return Objects.hash(firstname,lastname,age);
	}

	@Override
	public boolean equals(Object obj) {
		// TODO Auto-generated method stub
		return this.firstname.equals(((People) obj).firstname) &&this.lastname.equals(((People) obj).lastname) && this.age == ((People) obj).age;
	}
}

public class 编写equals方法 {

	public static void main(String[] args) {

		People p1 = new People("Jack","Tom", 12);
		System.out.println(p1.hashCode());

		HashMap<People, Integer> hashMap = new HashMap<People, Integer>();
		hashMap.put(p1, 1);
		hashMap.put(p1, 13);

//		p1.setAge(13);

		System.out.println(hashMap.get(p1));// 1
	}
}
//这段代码输出的结果为“null”，想必其中的原因大家应该都清楚了。
//
//因此，在设计hashCode方法和equals方法的时候，如果对象中的数据易变，则最好在equals方法和hashCode方法中不要依赖于该字段。

//import java.util.List;
//import java.util.Objects;
//public class Main {
//    public static void main(String[] args) {
//        List<Person> list = List.of(
//            new Person("Xiao", "Ming", 18),
//            new Person("Xiao", "Hong", 25),
//            new Person("Bob", "Smith", 20)
//        );
//        boolean exist = list.contains(new Person("Bob", "Smith", 20));
//        System.out.println(exist ? "测试成功!" : "测试失败!");
//    }
//}
//
//class Person {
//    String firstName;
//    String lastName;
//    int age;
//    public Person(String firstName, String lastName, int age) {
//        this.firstName = firstName;
//        this.lastName = lastName;
//        this.age = age;
//    }
//
//    public boolean equals(Object o){
//        if (o instanceof Person) {
//            Person p = (Person) o;
//            return Objects.equals(this.firstName, p.firstName) && this.age == p.age && Objects.equals(this.lastName, p.lastName);
//        }
//    return false;
//    }
//}